<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SoupAuthDomainDigest</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libsoup Reference Manual">
<link rel="up" href="ch02.html" title="Core API">
<link rel="prev" href="SoupAuthDomainBasic.html" title="SoupAuthDomainBasic">
<link rel="next" href="SoupCookie.html" title="SoupCookie">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="SoupAuthDomainBasic.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libsoup Reference Manual</th>
<td><a accesskey="n" href="SoupCookie.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#SoupAuthDomainDigest.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#SoupAuthDomainDigest.description" class="shortcut">Description</a>
                   | 
                  <a href="#SoupAuthDomainDigest.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#SoupAuthDomainDigest.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="SoupAuthDomainDigest"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="SoupAuthDomainDigest.top_of_page"></a>SoupAuthDomainDigest</span></h2>
<p>SoupAuthDomainDigest — Server-side "Digest" authentication</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="SoupAuthDomainDigest.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libsoup/soup.h&gt;

                    <a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigest-struct" title="SoupAuthDomainDigest">SoupAuthDomainDigest</a>;
<a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="returnvalue">SoupAuthDomain</span></a> *    <a class="link" href="SoupAuthDomainDigest.html#soup-auth-domain-digest-new" title="soup_auth_domain_digest_new ()">soup_auth_domain_digest_new</a>         (<em class="parameter"><code>const <span class="type">char</span> *optname1</code></em>,
                                                         <em class="parameter"><code>...</code></em>);

<span class="returnvalue">char</span> *              (<a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigestAuthCallback" title="SoupAuthDomainDigestAuthCallback ()">*SoupAuthDomainDigestAuthCallback</a>) (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *username</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="SoupAuthDomainDigest.html#soup-auth-domain-digest-set-auth-callback" title="soup_auth_domain_digest_set_auth_callback ()">soup_auth_domain_digest_set_auth_callback</a>
                                                        (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigestAuthCallback" title="SoupAuthDomainDigestAuthCallback ()"><span class="type">SoupAuthDomainDigestAuthCallback</span></a> callback</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> dnotify</code></em>);
<span class="returnvalue">char</span> *              <a class="link" href="SoupAuthDomainDigest.html#soup-auth-domain-digest-encode-password" title="soup_auth_domain_digest_encode_password ()">soup_auth_domain_digest_encode_password</a>
                                                        (<em class="parameter"><code>const <span class="type">char</span> *username</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *realm</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *password</code></em>);

#define             <a class="link" href="SoupAuthDomainDigest.html#SOUP-AUTH-DOMAIN-DIGEST-AUTH-CALLBACK:CAPS" title="SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK">SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK</a>
#define             <a class="link" href="SoupAuthDomainDigest.html#SOUP-AUTH-DOMAIN-DIGEST-AUTH-DATA:CAPS" title="SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA">SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA</a>
</pre>
</div>
<div class="refsect1">
<a name="SoupAuthDomainDigest.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain">SoupAuthDomain</a>
         +----SoupAuthDomainDigest
</pre>
</div>
<div class="refsect1">
<a name="SoupAuthDomainDigest.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigest--auth-callback" title='The "auth-callback" property'>auth-callback</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Read / Write
  "<a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigest--auth-data" title='The "auth-data" property'>auth-data</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="SoupAuthDomainDigest.description"></a><h2>Description</h2>
<p>
<a class="link" href="SoupAuthDomainBasic.html" title="SoupAuthDomainBasic"><span class="type">SoupAuthDomainBasic</span></a> handles the server side of HTTP "Digest"
authentication.
</p>
</div>
<div class="refsect1">
<a name="SoupAuthDomainDigest.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="SoupAuthDomainDigest-struct"></a><h3>SoupAuthDomainDigest</h3>
<pre class="programlisting">typedef struct _SoupAuthDomainDigest SoupAuthDomainDigest;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-auth-domain-digest-new"></a><h3>soup_auth_domain_digest_new ()</h3>
<pre class="programlisting"><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="returnvalue">SoupAuthDomain</span></a> *    soup_auth_domain_digest_new         (<em class="parameter"><code>const <span class="type">char</span> *optname1</code></em>,
                                                         <em class="parameter"><code>...</code></em>);</pre>
<p>
Creates a <a class="link" href="SoupAuthDomainDigest.html" title="SoupAuthDomainDigest"><span class="type">SoupAuthDomainDigest</span></a>. You must set the
<a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-REALM:CAPS" title="SOUP_AUTH_DOMAIN_REALM"><code class="literal">SOUP_AUTH_DOMAIN_REALM</code></a> parameter, to indicate the realm name to be
returned with the authentication challenge to the client. Other
parameters are optional.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>optname1</code></em> :</span></p></td>
<td>name of first option, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>option name/value pairs</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SoupAuthDomainDigestAuthCallback"></a><h3>SoupAuthDomainDigestAuthCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *              (*SoupAuthDomainDigestAuthCallback) (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *username</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Callback used by <a class="link" href="SoupAuthDomainDigest.html" title="SoupAuthDomainDigest"><span class="type">SoupAuthDomainDigest</span></a> for authentication purposes.
The application should look up <em class="parameter"><code>username</code></em> in its password database,
and return the corresponding encoded password (see
<a class="link" href="SoupAuthDomainDigest.html#soup-auth-domain-digest-encode-password" title="soup_auth_domain_digest_encode_password ()"><code class="function">soup_auth_domain_digest_encode_password()</code></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>domain</code></em> :</span></p></td>
<td>the domain</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
<td>the message being authenticated</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td>
<td>the username provided by the client</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>the data passed to <a class="link" href="SoupAuthDomainDigest.html#soup-auth-domain-digest-set-auth-callback" title="soup_auth_domain_digest_set_auth_callback ()"><code class="function">soup_auth_domain_digest_set_auth_callback()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the encoded password, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>username</code></em> is not a
valid user. <em class="parameter"><code>domain</code></em> will free the password when it is done with it.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="soup-auth-domain-digest-set-auth-callback"></a><h3>soup_auth_domain_digest_set_auth_callback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                soup_auth_domain_digest_set_auth_callback
                                                        (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigestAuthCallback" title="SoupAuthDomainDigestAuthCallback ()"><span class="type">SoupAuthDomainDigestAuthCallback</span></a> callback</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> dnotify</code></em>);</pre>
<p>
Sets the callback that <em class="parameter"><code>domain</code></em> will use to authenticate incoming
requests. For each request containing authorization, <em class="parameter"><code>domain</code></em> will
invoke the callback, and then either accept or reject the request
based on <em class="parameter"><code>callback</code></em>'s return value.
</p>
<p>
You can also set the auth callback by setting the
<a class="link" href="SoupAuthDomainDigest.html#SOUP-AUTH-DOMAIN-DIGEST-AUTH-CALLBACK:CAPS" title="SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK"><code class="literal">SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK</code></a> and
<a class="link" href="SoupAuthDomainDigest.html#SOUP-AUTH-DOMAIN-DIGEST-AUTH-DATA:CAPS" title="SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA"><code class="literal">SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA</code></a> properties, which can also be
used to set the callback at construct time.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>domain</code></em> :</span></p></td>
<td>the domain</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>the callback</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to <em class="parameter"><code>auth_callback</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dnotify</code></em> :</span></p></td>
<td>destroy notifier to free <em class="parameter"><code>user_data</code></em> when <em class="parameter"><code>domain</code></em>
is destroyed</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="soup-auth-domain-digest-encode-password"></a><h3>soup_auth_domain_digest_encode_password ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *              soup_auth_domain_digest_encode_password
                                                        (<em class="parameter"><code>const <span class="type">char</span> *username</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *realm</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *password</code></em>);</pre>
<p>
Encodes the username/realm/password triplet for Digest
authentication. (That is, it returns a stringified MD5 hash of
<em class="parameter"><code>username</code></em>, <em class="parameter"><code>realm</code></em>, and <em class="parameter"><code>password</code></em> concatenated together). This is
the form that is needed as the return value of
<a class="link" href="SoupAuthDomainDigest.html" title="SoupAuthDomainDigest"><span class="type">SoupAuthDomainDigest</span></a>'s auth handler.
</p>
<p>
For security reasons, you should store the encoded hash, rather
than storing the cleartext password itself and calling this method
only when you need to verify it. This way, if your server is
compromised, the attackers will not gain access to cleartext
passwords which might also be usable at other sites. (Note also
that the encoded password returned by this method is identical to
the encoded password stored in an Apache .htdigest file.)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td>
<td>a username</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>realm</code></em> :</span></p></td>
<td>an auth realm name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
<td>the password for <em class="parameter"><code>username</code></em> in <em class="parameter"><code>realm</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the encoded password</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SOUP-AUTH-DOMAIN-DIGEST-AUTH-CALLBACK:CAPS"></a><h3>SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK</h3>
<pre class="programlisting">#define SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK "auth-callback"
</pre>
<p>
Alias for the <a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigest--auth-callback" title='The "auth-callback" property'><span class="type">"auth-callback"</span></a> property.
(The <a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigestAuthCallback" title="SoupAuthDomainDigestAuthCallback ()"><span class="type">SoupAuthDomainDigestAuthCallback</span></a>.)
</p>
</div>
<hr>
<div class="refsect2">
<a name="SOUP-AUTH-DOMAIN-DIGEST-AUTH-DATA:CAPS"></a><h3>SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA</h3>
<pre class="programlisting">#define SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA     "auth-data"
</pre>
<p>
Alias for the <a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigest--auth-callback" title='The "auth-callback" property'><span class="type">"auth-callback"</span></a> property.
(The <a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigestAuthCallback" title="SoupAuthDomainDigestAuthCallback ()"><span class="type">SoupAuthDomainDigestAuthCallback</span></a>.)
</p>
</div>
</div>
<div class="refsect1">
<a name="SoupAuthDomainDigest.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="SoupAuthDomainDigest--auth-callback"></a><h3>The <code class="literal">"auth-callback"</code> property</h3>
<pre class="programlisting">  "auth-callback"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Read / Write</pre>
<p>Password-finding callback.</p>
</div>
<hr>
<div class="refsect2">
<a name="SoupAuthDomainDigest--auth-data"></a><h3>The <code class="literal">"auth-data"</code> property</h3>
<pre class="programlisting">  "auth-data"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Read / Write</pre>
<p>Data to pass to authentication callback.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>